/*
	Adobe Systems Incorporated(r) Source Code License Agreement
	Copyright(c) 2005 Adobe Systems Incorporated. All rights reserved.
	
	Please read this Source Code License Agreement carefully before using
	the source code.
	
	Adobe Systems Incorporated grants to you a perpetual, worldwide, non-exclusive, 
	no-charge, royalty-free, irrevocable copyright license, to reproduce,
	prepare derivative works of, publicly display, publicly perform, and
	distribute this source code and such derivative works in source or 
	object code form without any attribution requirements.  
	
	The name "Adobe Systems Incorporated" must not be used to endorse or promote products
	derived from the source code without prior written permission.
	
	You agree to indemnify, hold harmless and defend Adobe Systems Incorporated from and
	against any loss, damage, claims or lawsuits, including attorney's 
	fees that arise or result from your use or distribution of the source 
	code.
	
	THIS SOURCE CODE IS PROVIDED "AS IS" AND "WITH ALL FAULTS", WITHOUT 
	ANY TECHNICAL SUPPORT OR ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
	BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
	FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  ALSO, THERE IS NO WARRANTY OF 
	NON-INFRINGEMENT, TITLE OR QUIET ENJOYMENT.  IN NO EVENT SHALL MACROMEDIA
	OR ITS SUPPLIERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
	PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
	OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
	WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
	OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOURCE CODE, EVEN IF
	ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package mx.collaboration.xmpp.protocol
{
    
    import flash.events.*;
    import mx.collaboration.xmpp.protocol.XMPPStream;
    import mx.collaboration.xmpp.protocol.events.*;   
    
    /**
     * Authentication is successful.
     */
    [Event("authenticationSuccess")]
    
    /**
     * Authentication failed.
     */
    [Event("authenticationFailure")]         
    
    /**
     * Authenticators are used to authenticate an entity agains an
     * XMPP server. The class serves as the base class for all authenticators that are
     * supported by the XMPP Stream API. RFC 3920 specifies SASL as an authentication method (SASL
     * comes in many flavors, SASL Digest-MD5, SASL External, etc.). JEP-0078:Non-SASL
     * Authentication specifies other methods (SHA1 Digest, and Plaintext) which we 
     * will support by default.
     * 
     * Authentication mechanisms we will support are found in the xmpp.authenticators
     * package.     */
    public class Authenticator extends EventDispatcher
    {
        
        private var _channel:Channel;
        private var _stream:XMPPStream;
        
        public function Authenticator()
        {
            super();
        }
    
    	/**
    	 * Authenticators that extends this class must override this
    	 * method.    	 */
    	public function authenticate():void
        {            
        }
        
        /**
         * @private         */
        public function authenticationSuccess():void
        {
            dispatchEvent( new AuthenticatorEvent(AuthenticatorEvent.SUCCESS) );
        }
        
        /**
         * @private
         */
        public function authenticationFailure():void
        {
            dispatchEvent( new AuthenticatorEvent(AuthenticatorEvent.FAILURE) );
        }
    	
    	/**
    	 * The channel that this authenticator will authenticate
    	 * against.    	 */
        public function get channel():Channel
        {
            return this._channel;
        }
        
        public function set channel(channelArg:Channel):void
        {
            this._channel = channelArg;
            this._channel.addEventListener( ChannelEvent.DATA, onChannelData );
        }
    	
    	/**
    	 * A reference to the stream that this authenticator is authenticating
    	 * against.    	 */
        public function get stream():XMPPStream
        {
            return _stream;
        }
        public function set stream(streamArg:XMPPStream):void
        {
            _stream = streamArg;
        }
        
        /**
         * @private
         */
        public function onChannelData( event:ChannelEvent ):void
        {
            
        }
    }

}